Cream of the Crop 12

home *** CD-ROM | disk | FTP | other *** search

/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / OS2 / FYF110.ZIP / FYF.DOC next >

Wrap

Text File | 1996-03-21 | 27.1 KB | 656 lines

Find Your Files for OS/2 Find Your Files for OS/2 Version 1.1 March 5, 1996 by Jim Derr Member of Association of Shareware Professionals CSERVE ID 76266,2634 Shareware ............................. 3 HARDWARE SOFTWARE REQUIREMENTS .................. 4 INTRODUCTION ........................... 4 INSTALLATION ........................... 4 COMMAND LINE FORMAT AND PARAMETERS ................ 5 FYF command line format ................... 5 Conventions used: ...................... 5 SEARCH-SPECIFICATIONS: .................... 5 PERFORMING A FUZZY SEARCH: .................. 5 COMMAND LINE OPTIONS ..................... 6 /Z[RHSA] ........................ 6 /TOTALS ......................... 6 /NOLIST ......................... 6 /NET .......................... 6 /CD ........................... 6 /PAUSE ......................... 6 /DO ........................... 6 /+D ........................... 6 /IC ........................... 6 /SLx .......................... 6 /SGx .......................... 6 /Gx ........................... 6 /Lx ........................... 6 /#x ........................... 6 /=x ........................... 6 /Wx ........................... 6 /!x ........................... 6 /OFx .......................... 6 /FILEx ......................... 7 /PREx .......................... 7 /POSTx ......................... 7 /REGISTER ........................ 7 SPECIFYING LISTING FORMATS .................. 7 THE FYF.INI FILE ......................... 8 INI FILE CODING CONVENTIONS ................. 8 INI FILE PARAMETERS BY SECTION ................ 8 [defaults] ....................... 8 default-drives ................... 8 network-drives ................... 9 cd-drives ..................... 9 compressed-search ................. 9 output-file .................... 9 [user-exits] ...................... 9 pre-cmd ...................... 10 post-cmd ...................... 10 [display-format] .................... 10 output-line .................... 10 WHERE TO FIND THE MOST CURRENT VERSION .............. 12 SUPPORT FOR FYF AND QUESTIONS ................... 12 REVISION HISTORY ......................... 13 Find Your Files Version 1.1 User Manual Page-3- Shareware Shareware distribution gives users a chance to try software before buying it. If you try a shareware program and continue using it, you are expected to register. Individual programs differ on details -- some request registration while others require it, some specify a maximum trial period. With registration, you get anything from the simple right to continue using the software to an updated program with printed manual. Copyright laws apply to both shareware and commercial software, and the copyright holder retains all rights, with a few specific exceptions as stated below. Shareware authors are accomplished programmers, just like commercial authors, and the programs are of comparable quality. (In both cases, there are good programs and bad ones!) The main difference is in the method of distribution. The author specifically grants the right to copy and distribute the software, either to all and sundry or to a specific group. For example, some authors require written permission before a commercial disk vendor may copy their shareware. Shareware is a distribution method, not a type of software. You should find software that suits your needs and pocketbook, whether it's commercial or shareware. The shareware system makes fitting your needs easier, because you can try before you buy. And because the overhead is low, prices are low also. Shareware has the ultimate money-back guarantee -- if you don't use the product, you don't pay for it. FYF is a copyrighted shareware program by James Derr, owner of California Software Design. The evaluation edition of FYF is offered at no charge to any potential user for evaluation, but after a brief evaluation period users must register and pay for it. Feel free to share the evaluation edition with your friends and associates, but please do not give it away altered or as part of another system. The essence of "user-supported" software is to provide personal computer users with quality software without high prices, and yet to provide incentive for programmers to continue to develop new products. Disclaimer of Warranty Users of FYF must accept this disclaimer of warranty: FYF is supplied as-is. The author disclaims all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose. The author assumes no liability for damages, direct or consequential, which may result from use of FYF. This is a shareware product. If you find this utility useful please register and keep shareware alive. Only registered users will be supported.. Find Your Files Version 1.1 User Manual Page-4- HARDWARE SOFTWARE REQUIREMENTS FYF can be run on any OS/2 based PC having running OS/2 version 2.1 and greater and running on a 486 or better CPU. Token ring networks or Novell networks are also supported. INTRODUCTION The FYF program is designed to aid the user in quickly finding files on their PC. The program has numerous options giving the user a wide variety of search options. The FYF program can locate files on local drives, networked drives, and CD-ROM drives. In addition FYF can also search inside ZIP and LZH type compressed files. It will also allow the user to build file lists that can be used by other programs and systems. FYF options can be specified on the command line and/or specified in a user editable configuration file. Using a configuration file the user can setup their standard personal preferences which can be over-ridden via command line options. Multiple drives and search patterns can be specified and searched in one pass. FYF can automatically find all local, network, and CD-ROM drives. FAT and HPFS file systems are both supported. INSTALLATION Installation of the FYF program is very straight forward. UNZIP the contents of the FYFxxx.ZIP file into a temporary directory. Then simply copy the FYF.EXE file and the FYF.INI file into a directory that is listing in your PATH statement. Please NOTE the FYF.EXE and FYF.INI file MUST be installed into the same directory. Find Your Files Version 1.1 User Manual Page-5- COMMAND LINE FORMAT AND PARAMETERS FYF command line format: FYF [options] {search-spec } [options] Conventions used: Items appearing in brackets [] are optional items. Items appearing in braces {} can appear 1 to x number of times. SEARCH-SPECIFICATIONS: FYF uses an expanded search specification that provides the user with a high degree of flexibility. The search specification can include any one of the following: 1. Drive-letter(s): 2. \directory-name\ 3. Drive-letter:\directory-name\filespec 4. Drive-letters:\directory-name\filespec 5. file-spec If a drive letter is not included in the search specification the default is to search all available drives. FYF uses an expanded wild card format to specify what files to search for. A * in the filespec will match 0 or more characters and it may be used multiple times in the filespec. A ? in the filespec will match 1 character exactly and may be used multiple times in the filespec. To specify more than one file specification to search for enclose them in brackets and separate each filespec with a comma. For example: To search for all files on the D: drive that contain ADD or WIN you would code: D:\[*ADD*,*WIN*] To search for all files on the D: and E: looking for all files that begin with TIME you would code: DE:\TIME*.* PERFORMING A FUZZY SEARCH: FYF can also perform a fuzzy search. This is useful if you are trying to locate a file but don't know the exact filename. The fuzzy search routine will attempt to locate files that sound like the filename entered on the command line. To indicate that you want a fuzzy search use the ~ character as the first character of the file specification and DO NOT use any wildcard characters and DO NOT INCLUDE A FILE EXTENSION. EXAMPLE: The find all files on all drives that sound close to MINE you would code the following: ~MINE Find Your Files Version 1.1 User Manual Page-6- Find Your Files Version 1.1 User Manual Page-7- COMMAND LINE OPTIONS FYF has numerous command line options to satisfy almost any search request. Listed below are all the available options. The options may be placed before or after the search specification, or may be placed before and after the search specification. IMPORTANT: When a parameter has embedded spaces or slashes the entire parameter MUST be enclosed in quotes. EXAMPLE: Over-riding the output listing format FYF *.* "/OF$D $S $F" /Z[RHSA] Find files that have the specified attributes. R=readonly, H=hidden, S=system A=archive /TOTALS Produce a total line showing number of files found and total size of all files. /NOLIST Suppress the file listing of found files. /NET Include network drives when searching for files. /CD Include CD-ROM drives when searching for files. (NOTE: If you net use CD-ROM drive is it identified as a network drive and not a CD-ROM drive) /PAUSE Pause screen output when screen is full. /DO Only display the directories where the files are found, do not display the files. /+D Include directories found in the file list. /IC Also search inside compressed file types of .ZIP and .LZH for files. /SLx Find files with file sizes less than or equal to x. /SGx Find files with file sizes greater than or equal to x. /Gx Find files with creation/modification dates greater than or equal to date x. (Note: date format for x is mm-dd-yy) /Lx Find files with creation/modification dates less than or equal to date x. /#x Find files that are x days old. /=x Find files with creation/modification dates equal to x. /Wx Find files that were created/modified on weekday x. (Where x = 0=Sun, 1=Mon, 2=Tue, 3=Wed, 4=Thru, 5=Fri, 6=Sat) /!x Exclude files matching mask x from listing. Find Your Files Version 1.1 User Manual Page-8- /OFx Over ride default listing format with the x format. (See the section titled SPECIFYING LISTING FORMATS on how to code the x parameter) /FILEx Write the found file listing to file x. /PREx Run procedure x prior to scanning for files. Procedure x may be a program or an OS/2 command procedure. If the program or CMD file is in the path then only the name of the procedure can be specified. If it is not in the path then the entire drive and path must also be specified. /POSTx Run procedure x after scanning for files. (NOTE: The specified procedure is executed after the file listing is produced. If the /FILE parameter is used the file specified as the output listing file is closed prior to executing the POST procedure) /REGISTER Use this options to enter your registration serial number. This will suppress the shareware information screen. SPECIFYING LISTING FORMATS The /OFx parameter allows users to over ride the standard output listing format. The x is replaced with a series of symbolic variables. Any space between the symbolic variable is significant and the space will be included in the listing produced. The following variables can be used specifying the listing format: VARIABLE DESCRIPTION LENGTH $S = file size 8 characters $D = date of file 8 characters $T = time of file 8 characters $A = file attributes 4 characters $P = directory where found variable or fixed $F = name and ext. of file variable or fixed $N = filename only variable or fixed $X = file extension only variable or fixed The $P $F $N and $X symbolic variable may optionally have a field size specified immediately after the symbolic variable. E.G. $P30 means show directory where the file was found and make the field 30 characters in length. If a field size is specified the data displayed will be truncated if the field size is smaller than the data to display, or padded with blanks on the right to expand the data. If no size is specified the entire data will be displayed. The default format is: $S $D $T $A $P $F Find Your Files Version 1.1 User Manual Page-9- Find Your Files Version 1.1 User Manual Page-10- THE FYF.INI FILE FYF uses a file names FYF.INI to store user defaults and registration information. THIS FILE MUST RESIDE IN THE SAME DIRECTORY AS THE FYF.EXE FILE! The FYF.INI file is a plain ASCII file and uses the same format as WINDOWS type INI files. This format was selected so user defaults and options can be easily maintained by the user. INI FILE CODING CONVENTIONS The FYF.INI file is a plain ASCII text file. Comments are allowed in the FYF.INI file and must be preceded with a semicolon. Anything appearing after the semicolon is treated as a comment. The INI file is divided into sections. Each section name must be enclosed in brackets and the section name may not contain embedded blanks. The recognized section names are: [defaults] [display-format] [user-exits] [registered] The [registered] section is maintained by the FYF program and should not be altered by the user. If you specify an entry in the INI file and the same parameter is specified on the command line, the command line parameter will take precedence. Entries within each section are in the format: keyword=value The section names and keywords are not case sensitive. INI FILE PARAMETERS BY SECTION [defaults] This section allows the user to setup user defaults. This defaults will override the standard built-in defaults. Allowed keywords: default-drives network-drives cd-drives compressed-search output-file NOTE: When FYF builds the list of drives to search it removes duplicate drive letters before performing the search. default-drives The default-drives keyword indicates which drives to search Find Your Files Version 1.1 User Manual Page-11- for files on if no drives are specified along with the file specification(s) to search for. If default-drives is not specified all locally attached drives will be searched. EXAMPLE: default-drives=cd network-drives cd-drives The network-drives and cd-drives keywords take a 0 or a 1 indicating 1 for YES and 0 for NO. These allow the user to setup searching on network drives and cd-drives without having to use the /NET and /CD command line parameters. If network-drives is set to a 1 and the /NET command line switch is specified network drive searching is de-activated. The cd-drives keyword and /CD command line switch function the same way. compressed-search The compressed search keyword also takes a 0 or a 1 indicating 1 for YES and 0 for NO. The compressed-search keyword tells FYF to search for files inside compressed files. If this options is activated in the FYF.INI file it can be temporarily de-activated from the command line by using the /IC command line switch. output-file The output-file keyword tells FYF to put the results of the search into an output file instead of displaying the results on the screen. This is the same as using the /FILE command line option. If you specify the output-file keyword in the FYF.INI file and the /FILE parameter on the command line output will be directed to the screen. If you wish to redirect output to another filename and you have the output-file keyword in the FYF.INI file code the command line as follows: FYF *.c /FILE "/FILEe:\new.out" The first /FILE parm turns off writing to a file, the second /FILE parm turns on writing to a file using a new name. You can also do the following: FYF *.c /FILE > e:\new.out THE ADVANTAGE OF USING THE /FILE PARAMETER is: The file specified in the /FILE parameter or the output-file keyword in the FYF.INI file is closed prior to running the post-cmd user exit. If you use redirection the redirected file is NOT closed prior to running the post-cmd user exit. Using the /FILE parameter allows the following: FYF *.c "/FILEe:\fyf.out" "/POSTe e:\fyf.out" [user-exits] This section allows you to specify a program or a command file that will be executed prior to FYF searching for files Find Your Files Version 1.1 User Manual Page-12- and after the search is complete. Allowable keywords: pre-cmd post-cmd pre-cmd post-cmd These keywords define the program or command file to be run. The program or command file must be: 1) In the current directory. 2) In a directory listed in the path. 3) or fully qualified, including drive, and directory. If FYF can not locate the CMD or program to execute - or - the CMD or program ends with a non zero return code FYF will issue a message to the console. EXAMPLE: pre-cmd=e:\cmd\mycmd1.cmd post-cmd=e:\anyprog.exe [display-format] This section defines the format of the line displayed or written for all found files. Allowable Keywords: output-line output-line This defines the format of the line displayed for all found files. Eight different variable names may be used. $S = size of the file. $D = date of the file. $T = time of the file. $A = attributes of the file. $P = directory where the file was found. $F = full name of the file found. E.G. TEST.DAT $N = name portion of the file found. $X = extension portion of the file found. Spaces in the format string results in spaces on the screen. The $P,$F,$N and $X variables may optionally have a field size specified. If a field size is specified the data displayed will be truncated if the field size is smaller than the data to display, or padded with blanks on the right to expand the data. If no size is specified the entire data string is displayed on the screen. Any text that appears after the = will also be displayed on the screen or copied to redirected output. Using this facility allow you to dynamically create OS/2 CMD files. The output line format may also be entered on the command line Find Your Files Version 1.1 User Manual Page-13- using the /OF parameter. Just be sure to enclose the complete /OF parameter in quotes. E.G. FYF *.bat "/OFCOPY $P$F E:\TEMP" EXAMPLE: output-line=$N10 $X3 display filename for first ten positions, a blank and the file extension for three positions. The default is output-line=$s $d $t $a $p $f Find Your Files Version 1.1 User Manual Page-14- WHERE TO FIND THE MOST CURRENT VERSION The following BBS"s are distribution points. In addition you can leave mail on these system for me if you need technical assistance. Space BBS (415)323-4398 Main Distribution and Mail point. Kandy Shack (714)636-2667 Main Distribution and Mail point. Peter Norloff BBS (703) 385-4325 Additional Distributions Points: Comupserve In the OS2BVEN Forum Library 1 (OS/2 Shareware), keyword of FYF INTERNET http://www.sonic.net/~jderr (The most current version can always be found here first.) SUPPORT FOR FYF AND QUESTIONS Support can be obtained in three ways: 1) Via the INTERNET. I can be contacted via E-MAIL at jderr@sonic.net. 2) If you have access to CSERVE please send your questions to me via Cserve E-mail. (type GO MAIL at the Cserve prompt) My userid is 76266,2634. These are the preferred methods, I check for mail daily and will get back to you with an answer usually within two days. If you do not have access to the Internet or CSERVE send a note, letter, postcard to the address show below. Register users have priority but I will try to help anyone in need. You may also receive support by calling California Software Design at (707) 575-9868. California Software Design P.O. Box 15248 Santa Rosa, CA 94502 Find Your Files Version 1.1 User Manual Page-15- REVISION HISTORY v1.0 Jan 5 1996, Initial release. v1.1 March 8 1996, Added pre and post processing ability. Added FYF.INI file.